/*
   Copyright 2009 Abdulla Abdurakhmanov (abdulla@latestbit.com)
   Original sources are available at www.latestbit.com

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

package org.latestbit.smartobjects.network;

import java.nio.ByteBuffer;

import org.latestbit.smartobjects.exceptions.InvalidPacketReceivedException;

/**
 * Packet former interface
 * @author abdulla-a
 *
 */
public interface IPacketFormer {
	
	/**
	 * Event occurs when received any raw data from remote side
	 * @param buffer input byte buffer with raw data
	 */
	public void onReceiveRawPacket(ByteBuffer buffer);
	
	/**
	 * Gets ready (formed) packet if available
	 * @return ready (formed) packet or null if not any formed packets available
	 * @throws InvalidPacketReceivedException
	 */
	public ByteBuffer getReadyPacket() throws InvalidPacketReceivedException;
	
	/**
	 * Reset this packet former state
	 */
	public void reset();
}
